Platform Explorer / Nuxeo Platform 2023.17

Operation NuxeoDrive.CreateFolder (Nuxeo Drive: Create folder)

Description

Create a container with the given name as title in the container backing the file system item with the given id. Return the file system item backed by the created container as a JSON blob.
Operation id NuxeoDrive.CreateFolder
Category Services
Label Nuxeo Drive: Create folder
Requires
Since

Parameters

Name Description Type Required Default value
name Title of the container to create. string yes  
parentId Id of the file system item backed by the parent container. string yes  
overwrite Optional, whether to overwrite an existing container with the same title. boolean no false 

Signature

Inputs void
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.drive.operations.NuxeoDriveCreateFolder
Contributing Component org.nuxeo.drive.operations.NuxeoDriveGetRootsOperation

JSON Definition

{
  "id" : "NuxeoDrive.CreateFolder",
  "label" : "Nuxeo Drive: Create folder",
  "category" : "Services",
  "requires" : null,
  "description" : "Create a container with the given name as title in the container backing the file system item with the given id. Return the file system item backed by the created container as a JSON blob.",
  "url" : "NuxeoDrive.CreateFolder",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "name",
    "description" : "Title of the container to create.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "parentId",
    "description" : "Id of the file system item backed by the parent container.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "overwrite",
    "description" : "Optional, whether to overwrite an existing container with the same title.",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  } ]
}